widget: Add gtk_widget_compute_bounds()

The first in a set of functions intended to query widget coordinates
from another widget's coordinate system.

diff --git a/docs/reference/gtk/gtk4-sections.txt b/docs/reference/gtk/gtk4-sections.txt
index 5417c28c78f7853c72945e7e49f4637435ee81c2..6c5b389736490dc1733a6c67cf6f7fc29dd49280 100644 (file)
--- a/docs/reference/gtk/gtk4-sections.txt
+++ b/docs/reference/gtk/gtk4-sections.txt
@@ -4327,6 +4327,7 @@ gtk_widget_get_allocated_baseline
 gtk_widget_get_allocated_size
 gtk_widget_get_width
 gtk_widget_get_height
+gtk_widget_compute_bounds
 gtk_widget_contains
 gtk_widget_pick
 gtk_widget_get_can_default

diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index d4c42d87ab199c9d56b9683f8af5386773de4817..9bda1b729d5323f46ac19667100077623fdd52cb 100644 (file)
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -11574,6 +11574,54 @@ gtk_widget_get_own_allocation (GtkWidget    *widget,
   allocation->height = priv->allocation.height -margin.top - margin.bottom;
 }
 
+/**
+ * gtk_widget_compute_bounds:
+ * @widget: the #GtkWidget to query
+ * @target: the #GtkWidget 
+ * @bounds: (out caller-allocates): the rectangle taking the bounds
+ *
+ * Computes the bounds for @widget in the coordinate space of @target.
+ * FIXME: Explain what "bounds" are.
+ *
+ * If the operation is successful, %TRUE is returned. If @widget has no
+ * bounds or the bounds cannot be expressed in @target's coordinate space
+ * (for example if both widgets are in different windows), %FALSE is
+ * returned and @bounds is set to the zero rectangle.
+ * 
+ * It is valid for @widget and @target to be the same widget.
+ *
+ * Returns: %TRUE if the bonuds could be computed
+ **/
+gboolean
+gtk_widget_compute_bounds (GtkWidget       *widget,
+                           GtkWidget       *target,
+                           graphene_rect_t *out_bounds)
+{
+  GtkAllocation alloc;
+
+  g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
+  g_return_val_if_fail (GTK_IS_WIDGET (target), FALSE);
+  g_return_val_if_fail (out_bounds != NULL, FALSE);
+
+  gtk_widget_get_own_allocation (widget, &alloc);
+  if (!gtk_widget_translate_coordinates (widget,
+                                         target,
+                                         alloc.x, alloc.y,
+                                         &alloc.x, &alloc.y))
+    {
+      graphene_rect_init_from_rect (out_bounds, graphene_rect_zero ());
+      return FALSE;
+    }
+
+  graphene_rect_init (out_bounds, 
+                      alloc.x,
+                      alloc.y,
+                      alloc.width,
+                      alloc.height);
+
+  return TRUE;
+}
+
 /**
  * gtk_widget_get_allocated_width:
  * @widget: the widget to query

diff --git a/gtk/gtkwidget.h b/gtk/gtkwidget.h
index 2892bc8eaa5d3e066dbbc40010923bffff3b95c7..22f2daf27c8dc6fbb52e682c8fa0fa6f977d1a47 100644 (file)
--- a/gtk/gtkwidget.h
+++ b/gtk/gtkwidget.h
@@ -623,6 +623,11 @@ GDK_AVAILABLE_IN_ALL
 void                  gtk_widget_get_allocation         (GtkWidget     *widget,
                                                          GtkAllocation *allocation);
 GDK_AVAILABLE_IN_ALL
+gboolean              gtk_widget_compute_bounds         (GtkWidget     *widget,
+                                                         GtkWidget     *other,
+                                                         graphene_rect_t *out_bounds);
+
+GDK_AVAILABLE_IN_ALL
 int                   gtk_widget_get_width              (GtkWidget     *widget);
 GDK_AVAILABLE_IN_ALL
 int                   gtk_widget_get_height             (GtkWidget     *widget);